
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of XYMOND_CLIENT</TITLE>
</HEAD><BODY>
<H1>XYMOND_CLIENT</H1>
Section: Maintenance Commands (8)<BR>Updated: Version 4.3.13:  7 Jan 2014<BR><A HREF="#index">Index</A>
<A HREF="../index.html">Return to Main Contents</A><HR>

<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>

xymond_client - xymond worker module for client data
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>

<B>xymond_channel --channel=client xymond_client [options]</B>

<P>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>

xymond_client is a worker module for xymond, and as such it is normally
run via the
<I><A HREF="../man8/xymond_channel.8.html">xymond_channel</A>(8)</I>

program. It receives xymond client messages sent from systems that
have the the Xymon client installed, and use the client data to
generate the Xymon status messages for the cpu-, disk-, memory- and
procs-columns. It also feeds Xymon data messages with the netstat-
and vmstat-data collected by the client.
<P>
When generating these status messages from the client data, xymond_client
will use the configuration rules defined in the 
<I><A HREF="../man5/analysis.cfg.5.html">analysis.cfg</A>(5)</I>

file to determine the color of each status message.
<P>
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>

<DL COMPACT>
<DT>--clear-color=COLOR<DD>
Define the color used when sending &quot;msgs&quot;, &quot;files&quot; or &quot;ports&quot; reports
and there are no rules to check for these statuses. The default is
to show a &quot;clear&quot; status, but some people prefer to have it &quot;green&quot;.
If you would rather prefer not to see these status columns at all, then
you can use the &quot;--no-clear-msgs&quot;, &quot;--no-clear-files&quot; and &quot;--no-clear-ports&quot;
options instead.
<P>
<DT>--no-clear-msgs<DD>
If there are no logfile checks, the &quot;msgs&quot; column will show a &quot;clear&quot;
status. If you would rather avoid having a &quot;msgs&quot; column, this option
causes xymond_client to not send in a clear &quot;msgs&quot; status.
<P>
<DT>--no-clear-files<DD>
If there are no file checks, the &quot;files&quot; column will show a &quot;clear&quot;
status. If you would rather avoid having a &quot;files&quot; column, this option
causes xymond_client to not send in a clear &quot;files&quot; status.
<P>
<DT>--no-clear-ports<DD>
If there are no port checks, the &quot;ports&quot; column will show a &quot;clear&quot;
status. If you would rather avoid having a &quot;ports&quot; column, this option
causes xymond_client to not send in a clear &quot;ports&quot; status.
<P>
<DT>--no-ps-listing<DD>
Normally the &quot;procs&quot; status message includes the full process-listing
received from the client. If you prefer to just have the monitored
processes shown, this option will turn off the full ps-listing.
<P>
<DT>--no-port-listing<DD>
Normally the &quot;ports&quot; status message includes the full netstat-listing
received from the client. If you prefer to just have the monitored
ports shown, this option will turn off the full netstat-listing.
<P>
<DT>--config=FILENAME<DD>
Sets the filename for the 
<I>analysis.cfg</I>

file. The default value is &quot;etc/analysis.cfg&quot; below the Xymon
server directory.
<P>
<DT>--unknownclientosok<DD>
Expect and attempt to parse clients with unknown CLIENTOS types.
Useful if you're submitting custom host responses with file or msgs
data that you'd like to parse.
<P>
<DT>--dump-config<DD>
Dumps the configuration after parsing it. May be useful to track
down problems with configuration file errors.
<P>
<DT>--test<DD>
Starts an interactive session where you can test the analysis.cfg
configuration.
<P>
<DT>--collectors=COLLECTOR1[,COLLECTOR2,...]<DD>
Limit the set of collector modules that xymond_client will handle. This
is not normally used except for running experimental versions of the
program.
<P>
<DT>--debug<DD>
Enable debugging output.
<P>
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>FILES</H2>

<DL COMPACT>
<DT>~xymon/server/etc/analysis.cfg<DD>
<P>
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>BUGS</H2>

The &quot;disk&quot; status cannot handle filesystems containing whitespace in the
filesystem (device) name.
<P>
<A NAME="lbAH">&nbsp;</A>
<H2>SEE ALSO</H2>

<A HREF="../man5/analysis.cfg.5.html">analysis.cfg</A>(5), <A HREF="../man8/xymond.8.html">xymond</A>(8), <A HREF="../man8/xymond_channel.8.html">xymond_channel</A>(8), <A HREF="../man7/xymon.7.html">xymon</A>(7)
<P>
<P>

<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT><A HREF="#lbAB">NAME</A><DD>
<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT><A HREF="#lbAE">OPTIONS</A><DD>
<DT><A HREF="#lbAF">FILES</A><DD>
<DT><A HREF="#lbAG">BUGS</A><DD>
<DT><A HREF="#lbAH">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 09:25:35 GMT, January 07, 2014
</BODY>
</HTML>
